Carbon


FindFolderRouting

Header: Folders.h Carbon status: Supported

Finds the destination folder from a matching folder routing structure for the specified file.

OSErr FindFolderRouting (
    OSType fileType, 
    FolderType routeFromFolder, 
    FolderType *routeToFolder, 
    RoutingFlags *flags
);
Parameter descriptions
fileType

Pass the file type specified in the appropriate folder routing structure for the file for which you wish to find a destination folder.

routeFromFolder

Pass the folder type of the “from” folder for which you wish to find a “to” folder; see “Folder Type Constants” for descriptions of possible values. An item dropped on the folder specified in this parameter will be routed to the folder specified in the routeToFolder parameter.

routeToFolder

A pointer to a value of type FolderType. On return, the value is set to the folder type of the destination folder. See “Folder Type Constants” for descriptions of possible values

flags

Reserved; pass 0.

function result

A result code.

DISCUSSION

Both the file type and the folder type specified must match those of a folder routing structure in the global routing list for the FindFolderRouting function to succeed.

SPECIAL CONSIDERATIONS

The system initializes the Folder Manager’s routing tables with a resource of type 'nrt#' located in the System file. You should not modify or rely on the contents of the 'nrt#' resource in the System file; use only the FindFolderRouting function to find the appropriate folder routing information.

VERSION NOTES

Supported under Mac OS 8 and later.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)